home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / dev / misc / egs.lha / EGS / EGS_Devels / doc / egsintui.doc < prev    next >
Text File  |  1993-02-16  |  34KB  |  1,773 lines
  1. /*
  2. *  $
  3. *  $ FILE     : egsintui.doc
  4. *  $ VERSION  : 1
  5. *  $ REVISION : 1
  6. *  $ DATE     : 08-Feb-93 09:55
  7. *  $
  8. *  $ Author   : mvk
  9. *  $
  10. *
  11. *
  12. * (c) Copyright 1990/93 VIONA Development
  13. *     All Rights Reserved
  14. *
  15. */
  16. egsintui.library/EI_ActivateGadget
  17. egsintui.library/EI_ActivateWindow
  18. egsintui.library/EI_AddGadget
  19. egsintui.library/EI_AddGList
  20. egsintui.library/EI_AddToMenu
  21. egsintui.library/EI_AddToItem
  22. egsintui.library/EI_BackCalcProportional
  23. egsintui.library/EI_BeginRefresh
  24. egsintui.library/EI_CalcProportional
  25. egsintui.library/EI_ClearPointer
  26. egsintui.library/EI_CloneColor
  27. egsintui.library/EI_CloseScreen
  28. egsintui.library/EI_CloseWindow
  29. egsintui.library/EI_CreateItem
  30. egsintui.library/EI_CreateLeave
  31. egsintui.library/EI_CreateMenu
  32. egsintui.library/EI_DeactivateWindow
  33. egsintui.library/EI_DefaultColor
  34. egsintui.library/EI_DoubleClick
  35. egsintui.library/EI_EndRefresh
  36. egsintui.library/EI_FindMenuItem
  37. egsintui.library/EI_FindSubMenu
  38. egsintui.library/EI_FreeMenu
  39. egsintui.library/EI_GetDefaultScreen
  40. egsintui.library/EI_GetPrefFont
  41. egsintui.library/EI_GetPrefPointer
  42. egsintui.library/EI_GetWinColor
  43. egsintui.library/EI_Interpret
  44. egsintui.library/EI_Interpret1Param
  45. egsintui.library/EI_Interpret2Param
  46. egsintui.library/EI_InterpretStacked
  47. egsintui.library/EI_LockIntuition
  48. egsintui.library/EI_ModifyIDCMP
  49. egsintui.library/EI_MoveWindow
  50. egsintui.library/EI_ObtainColor
  51. egsintui.library/EI_OffGadget
  52. egsintui.library/EI_OffGList
  53. egsintui.library/EI_OffMenuItem
  54. egsintui.library/EI_OnGadget
  55. egsintui.library/EI_OnGList
  56. egsintui.library/EI_OnMenuItem
  57. egsintui.library/EI_OpenScreen
  58. egsintui.library/EI_OpenWindow
  59. egsintui.library/EI_PutMenuHome
  60. egsintui.library/EI_PutMenuOut
  61. egsintui.library/EI_RedrawGadgetList
  62. egsintui.library/EI_RefreshGadget
  63. egsintui.library/EI_RefreshGList
  64. egsintui.library/EI_RefreshScreen
  65. egsintui.library/EI_RefreshWindow
  66. egsintui.library/EI_ReleaseColor
  67. egsintui.library/EI_RemoveGadget
  68. egsintui.library/EI_RemoveGList
  69. egsintui.library/EI_ReportMouse
  70. egsintui.library/EI_ScrollWindow
  71. egsintui.library/EI_SetMenuStrip
  72. egsintui.library/EI_SetPointer
  73. egsintui.library/EI_SetWindowTitles
  74. egsintui.library/EI_SizeWindow
  75. egsintui.library/EI_SleepWindow
  76. egsintui.library/EI_SysRequest
  77. egsintui.library/EI_ToggleMenuItem
  78. egsintui.library/EI_UnlockIntuition
  79. egsintui.library/EI_WakeWindow
  80. egsintui.library/EI_WindowBorder
  81. egsintui.library/EI_WindowToBack
  82. egsintui.library/EI_WindowToFront
  83.  
  84.  
  85. egsintui.library/EI_ActivateGadget
  86.  
  87. NAME
  88.   EI_ActivateGadget   activate a string gadget
  89.  
  90. SYNOPSIS
  91.   EI_ActivateGadget(win, gad, force)
  92.             A0   A1   D0
  93.  
  94.   EI_WindowPtr    win;
  95.   EI_GadgetPtr    gad;
  96.   BOOL            force;
  97.  
  98. FUNCTION
  99.   Attempts to activate a string gadget. If force is false this will only succeed
  100.   if the gadgets window is active and no other string gadget is active. If force
  101.   is true this call will allways succeed, by deactivating other gadgets and
  102.   activating the gadgets window.
  103.  
  104. INPUTS
  105.   win   : gadgets window
  106.   gad   : pointer to the gadget
  107.   force : true, to force activation
  108.  
  109. RETURNS
  110.  
  111.  
  112.  
  113.  
  114. egsintui.library/EI_ActivateWindow
  115.  
  116. NAME
  117.   EI_ActivateWindow   activate window
  118.  
  119. SYNOPSIS
  120.   EI_ActivateWindow(win)
  121.             A0
  122.  
  123.   EI_WindowPtr   win;
  124.  
  125. FUNCTION
  126.   Activates a window, the actual active window will become deactivated.
  127.  
  128. INPUTS
  129.   win   : pointer to window
  130.  
  131. RETURNS
  132.  
  133.  
  134.  
  135.  
  136. egsintui.library/EI_AddGadget
  137.  
  138. NAME
  139.   EI_AddGadget    add gadget to window
  140.  
  141. SYNOPSIS
  142.   EI_AddGadget(win, gad)
  143.            A0   A1
  144.  
  145.   EI_WindowPtr    win;
  146.   EI_GadgetPtr    gad;
  147.  
  148. FUNCTION
  149.   Adds a gadget to the windows gadget list and displays it. If this is a
  150.   master gadget all asociated son gadgets are also added. If the gadget is not
  151.   disabled using gadget flag EI_gadgetInactive, the user can reach it
  152.   immediately.
  153.  
  154. INPUTS
  155.   win    : window to which to add
  156.   gad    : pointer to gadget
  157.  
  158. RETURNS
  159.  
  160.  
  161.  
  162.  
  163. egsintui.library/EI_AddGList
  164.  
  165. NAME
  166.   EI_AddGList   add several gadgets
  167.  
  168. SYNOPSIS
  169.   EI_AddGList(win, gad, num)
  170.           A0   A1   D0
  171.  
  172.   EI_WindowPtr   win;
  173.   EI_GadgetPtr   gad;
  174.   WORD           num;
  175.  
  176. FUNCTION
  177.   Adds a list of gadgets to a windows gadget list, and displays them. If there
  178.   are master gadgets in the list, all son gadgets will be added too.
  179.  
  180. INPUTS
  181.   win    : pointer to window
  182.   gad    : pointer to first gadget in list
  183.   num    : number of gadgets in list
  184.  
  185. RETURNS
  186.  
  187.  
  188.  
  189.  
  190. egsintui.library/EI_AddToMenu
  191.  
  192. NAME
  193.   EI_AddToItem   add a menu item to an main menu
  194.  
  195. SYNOPSIS
  196.   EI_AddToItem(menu, add)
  197.            A0    A1
  198.  
  199.   EI_MenuPtr       menu;
  200.   EI_MenuItemPtr   add;
  201.  
  202. FUNCTION
  203.   Adds an item 'add' (or an submenu leaf) to a menu. Make sure that the
  204.   item 'add' is full buildt up, when you add it to the root menu,
  205.   because several initialisations are done to 'add' during this routine.
  206.  
  207. INPUTS
  208.   menu    : The menu to be extended
  209.   add     : The item to be included in the root menu
  210.  
  211. RESULTS
  212.  
  213.  
  214.  
  215.  
  216. egsintui.library/EI_AddToItem
  217.  
  218. NAME
  219.   EI_AddToItem   add a sub menu item to an item
  220.  
  221. SYNOPSIS
  222.   EI_AddToItem(item, add)
  223.            A0    A1
  224.  
  225.   EI_MenuItemPtr   item,add;
  226.  
  227. FUNCTION
  228.   Adds an item 'add' (or an submenu leaf) to an item 'item'. If the item
  229.   has none submenu attached yet, this routine creates one. Make sure that
  230.   the subitem 'add' is full bulidt up, when you add it to the submenu,
  231.   because several initialisations are done to 'add' during this routine.
  232.  
  233. INPUTS
  234.   item    : The item to become an item with a sub menu
  235.   add     : The item to be included in the sub menu
  236.  
  237. RESULTS
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244. egsintui.library/EI_BeginRefresh
  245.  
  246. NAME
  247.   EI_BeginRefresh   begin refresh for window
  248.  
  249. SYNOPSIS
  250.   done = EI_BeginRefresh(win, key)
  251.   D0                     A0   D0
  252.  
  253.   BOOL           done;
  254.   EI_WindowPtr   win;
  255.   ULONG          key;
  256.  
  257. FUNCTION
  258.   Attempts to start a refresh for a window. For more information look at
  259.   egslayers.library/EL_BeginUpdate.
  260.  
  261.   The border, the gadgets and the rendering of the intuigfx programm in the
  262.   window field .render, is carried out automagically by the egsintui.library.
  263.  
  264. INPUTS
  265.   key    : refresh key
  266.  
  267. RETURNS
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274. egsintui.library/EI_ClearPointer
  275.  
  276. NAME
  277.   EI_ClearPointer   remove windows pointer
  278.  
  279. SYNOPSIS
  280.   EI_ClearPointer(win)
  281.           A0
  282.  
  283.   EI_WindowPtr win;
  284.  
  285. FUNCTION
  286.   Removes the windows pointer and uses the default pointer again.
  287.  
  288. INPUTS
  289.  
  290. RETURNS
  291.  
  292.  
  293.  
  294. egsintui.library/EI_CloneColor
  295.  
  296. NAME
  297.   EI_CloneColor    clone a screen color
  298.  
  299. SYNOPSIS
  300.   newcolor = EI_CloneColor(scr,color)
  301.              A0  D0
  302.  
  303.   EI_ScreenPtr  scr;
  304.   ULONG         newcolor, color;
  305.  
  306. FUNCTION
  307.   Clones the lock on an allready locked screen color. The resulting color
  308.   has to be released, when not needed any more.
  309.  
  310. INPUTS
  311.  
  312. RETURNS
  313.  
  314.  
  315.  
  316.  
  317. egsintui.library/EI_CloseScreen
  318.  
  319. NAME
  320.   EI_CloseScreen   close a screen
  321.  
  322. SYNOPSIS
  323.   EI_CloseScreen(scr)
  324.          A0
  325.  
  326.   EI_ScreenPtr   scr;
  327.  
  328. FUNCTION
  329.   Closes a screen that was opened using EI_OpenScreen, and all windows which
  330.   reside on it. All memory and structures that are linked to this screen
  331.   E_Screen, EL_LayerInfo etc. are freed.
  332.  
  333. INPUTS
  334.  
  335. RETURNS
  336.  
  337.  
  338.  
  339.  
  340. egsintui.library/EI_CloseWindow
  341.  
  342. NAME
  343.   EI_CloseWindow   close a window
  344.  
  345. SYNOPSIS
  346.   EI_CloseWindow(win)
  347.          A0
  348.  
  349.   EI_WindowPtr   win;
  350.  
  351. FUNCTION
  352.   Closes a window, opened by EI_OpenWindow, frees all linked structures like
  353.   layer, rastport etc. If it was the last window on the default screen, the
  354.   default screen is also closed.
  355.  
  356. INPUTS
  357.  
  358. RETURNS
  359.  
  360.  
  361.  
  362. egsintui.library/EI_CreateItem
  363.  
  364. NAME
  365.   EI_CreateItem    create a menu item
  366.  
  367. SYNOPSIE
  368.   item = EI_CreateItem(font, name, id, key, toggle);
  369.   D0                   A0    A1    D0  D1   D2
  370.  
  371.   EI_MenuItemPtr   item;
  372.   EG_EFontPtr      font;
  373.   char            *name;
  374.   LONG             id;
  375.   char             key;
  376.   BOOL             toggle;
  377.  
  378. FUNCTION
  379.   Creates an menu item to be attached to a menu or sub menu by EI_AddToMenu or
  380.   EI_AddToItem. The font 'font' has to be kept open, as long as the menu is
  381.   being used. If char is no null byte, the item has a hot key. If toggle is
  382.   TRUE then the item has a check mark, and can be toggeled.
  383.  
  384.  
  385.  
  386. INPUTS
  387.   font    : The font to be used for the item. The suggestion for the font
  388.         is the screen font if you attache the menu to screen else the
  389.         windows font.
  390.   name    : The name of the item.
  391.   id      : The id to be used and to identify the item.
  392.   key     : A shortcut character or a NULL for no shortcut
  393.   toggle  : A flag, determinig if the item is toggleable
  394.  
  395.  
  396. RETURNS
  397.   item - the created menu-item or NULL for failure
  398.  
  399.  
  400. EXAMPLE
  401.  
  402. /*
  403. ** Author: Markus van Kempen
  404. ** Date  : 17. Dezember 1992
  405. **
  406. ** Input : EG_EFontPtr = Point to a Font for Menu
  407. ** Output: EI_MenuPtr  = Point to the Menu-Structure
  408. **                       for assign to the EI_NewWindow-Structure
  409. **                       --> "newWindow.menu=menu"
  410. **
  411. ** This is a routine for init a menu structure.
  412. ** It calls the functions from egsintui.library.
  413. ** If you want to change the menus, you must
  414. ** only change this file.
  415. **
  416. **
  417. ** (c) by VIONA-Development 1992/93
  418. **
  419. */
  420.  
  421. EI_MenuPtr        EI_CreateMenu(void);
  422. EI_MenuItemPtr    EI_CreateLeave(void);
  423.  
  424. EI_MenuPtr InitMenu(EG_EFontPtr font)
  425. {
  426.  
  427.   EI_MenuPtr      menu;
  428.   EI_MenuItemPtr  item1,item2;
  429.   struct TextAttr *attr;
  430.  
  431.   if(font == NULL)
  432.   {
  433.      attr = (struct TextAttr *) EI_GetPrefFont(1);
  434.      font = (EG_EFontPtr)       EG_OpenFont(attr);
  435.  
  436.   }
  437.  
  438.  
  439.  /** Create a complex menu, which will look like this
  440.  
  441.     +----------------------------+------------+
  442.     | Project                    | Flags      |
  443.     +------------+---------------+-----------++
  444.     +------------+               +-----------+
  445.     | Load     O |               | -/ Flag 1 |
  446.     |  Save... > +--------------+| -/ Flag 2 |
  447.     | Rename     | Save       S ||    Flag 3 |
  448.     | New      N | Save as    A ||    Flag 4 |
  449.     | Close    X | Save & Close ||    Flag 5 |
  450.     | About      +--------------+|    Flag 6 |
  451.     | Quit     Q |               |    Flag 7 |
  452.     +------------+               +-----------+
  453.  
  454.  **/
  455.  
  456.   menu  = EI_CreateMenu();
  457.     item1 = EI_CreateItem(font,"Project",0,0,0);
  458.       EI_AddToItem(item1,EI_CreateLeave());
  459.       EI_AddToItem(item1,EI_CreateItem(font,"Load", 0x1,'O',0));
  460.     item2=EI_CreateItem(font,"Save",0x10,0,0);
  461.       EI_AddToItem(item2,EI_CreateItem(font,"Save"         ,0x11,'S',0));
  462.       EI_AddToItem(item2,EI_CreateItem(font,"Save as"      ,0x12,'A',0));
  463.       EI_AddToItem(item2,EI_CreateItem(font,"Save & Close" ,0x13,'C',0));
  464.     EI_AddToItem(item1,item2);
  465.       EI_AddToItem(item1,EI_CreateItem(font,"New",  0x3,'N',0));
  466.       EI_AddToItem(item1,EI_CreateItem(font,"Close",0x4,'X',0));
  467.       EI_AddToItem(item1,EI_CreateItem(font,"About",0x5,NULL,0));
  468.       EI_AddToItem(item1,EI_CreateItem(font,"Quit" ,0x6,'Q',0));
  469.     EI_AddToMenu(menu,item1);
  470.     item1 = EI_CreateItem(font,"Flags",0,0,0);
  471.       EI_AddToItem(item1,EI_CreateLeave());
  472.       EI_AddToItem(item1,EI_CreateItem(font,"Flag 1",0x20,0,1));
  473.       EI_AddToItem(item1,EI_CreateItem(font,"Flag 2",0x21,0,1));
  474.       EI_AddToItem(item1,EI_CreateItem(font,"Flag 3",0x22,0,1));
  475.       EI_AddToItem(item1,EI_CreateItem(font,"Flag 4",0x23,0,1));
  476.       EI_AddToItem(item1,EI_CreateItem(font,"Flag 5",0x24,0,1));
  477.       EI_AddToItem(item1,EI_CreateItem(font,"Flag 6",0x25,0,1));
  478.       EI_AddToItem(item1,EI_CreateItem(font,"Flag 7",0x26,0,1));
  479.     EI_AddToMenu(menu,item1);
  480.   return(menu);
  481. }
  482.  
  483.  
  484.  
  485. egsintui.library/EI_CreateLeave
  486.  
  487. NAME
  488.   EI_CreateLeave    create an item to detach a submenu
  489.  
  490. SYNOPSIS
  491.   item = EI_CreateLeave()
  492.   D0
  493.  
  494.   EI_MenuItemPtr   item;
  495.  
  496. FUNCTION
  497.   Creates a menu item that gives the user the ability to detach a submenu
  498.   from its item. You must add this item to the sub menu using EI_AddToItem.
  499.  
  500. INPUTS
  501.  
  502. RESULTS
  503.   item : Detach menu item
  504.  
  505.  
  506.  
  507.  
  508. egsintui.library/EI_CreateMenu
  509.  
  510. NAME
  511.   EI_CreateMenu    creates a root menue
  512.  
  513. SYNOPSIS
  514.   menu = EI_CreateMenu()
  515.   D0
  516.  
  517.   EI_MenuPtr   menu;
  518.  
  519. FUNCTION
  520.   Creates a root menu. Items can be attached to this menu using EI_AddToMenu.
  521.   See EI_CreateItem for more informations.
  522.  
  523. INPUTS
  524.  
  525. RESULTS
  526.   menu : An empty root menu structure.
  527.  
  528.  
  529.  
  530.  
  531. egsintui.library/EI_DeactivateWindow
  532.  
  533. NAME
  534.   EI_DeactivateWindow    deactivate window
  535.  
  536. SYNOPSIS
  537.   EI_DeactivateWindow(win)
  538.               A0
  539.  
  540.   EI_WindowPtr   win;
  541.  
  542. FUNCTION
  543.   Deactivates a window, if it was currently the active one. The window that
  544.   was active before this window, will become active again.
  545.  
  546. INPUTS
  547.  
  548. RETURNS
  549.  
  550.  
  551.  
  552. egsintui.library/EI_DefaultColor
  553.  
  554. NAME
  555.   EI_DefaultColor   get a default color
  556.  
  557. SYNOPSIS
  558.   color = EI_DefaultColor(depth, tag)
  559.   D0                      D0     D1
  560.  
  561.   ULONG      color;
  562.   WORD       depth;
  563.   ULONG      tag;
  564.  
  565. FUNCTION
  566.   Returns the preference value of a screen color.
  567.  
  568. INPUTS
  569.   tag must be a element of the colortags (EIC_...) defined in egsintui.h
  570.  
  571. RETURNS
  572.  
  573.  
  574.  
  575.  
  576. egsintui.library/EI_DoubleClick
  577.  
  578. NAME
  579.   EI_DoubleClick   check for double click
  580.  
  581. SYNOPSIS
  582.   double = EI_DoubleClick(StartSec, StartMicros, EndSec, EndMicros)
  583.   D0                      D0        D1           D2      D3
  584.  
  585.   BOOL       double;
  586.   ULONG      StartSec, StartMicros, EndSec, EndMicros;
  587.  
  588. FUNCTION
  589.   Checks if two mouse clicks are one double click, by checking if the time
  590.   between the ticks is small enough (actually calls
  591.   intuition.library/DoubleClick).
  592.  
  593. INPUTS
  594.  
  595. RETURNS
  596.  
  597.  
  598.  
  599.  
  600. egsintui.library/EI_EndRefresh
  601.  
  602. NAME
  603.   EI_EndRefresh
  604.  
  605. SYNOPSIS
  606.   EI_EndRefresh(win, ready)
  607.         A0   D0
  608.  
  609.   EI_WindowPtr    win;
  610.   BOOL            ready;
  611.  
  612. FUNCTION
  613.   Ends a refresh segment. Look at egslayers.library/EndUpdate for more
  614.   information.
  615.  
  616. INPUTS
  617.  
  618. RETURNS
  619.  
  620.  
  621.  
  622.  
  623. egsintui.library/EI_FindMenuItem
  624.  
  625. NAME
  626.   EI_FindMenuItem
  627.  
  628. SYNOPSIS
  629.   item = EI_FindMenuItem(menu, id)
  630.   D0                     A0    D0
  631.  
  632.   EI_MenuItemPtr   item;
  633.   EI_MenuPtr       menu;
  634.   LONG             id;
  635.  
  636. FUNCTION
  637.   Searches recursively for a menu item in the described menu. Returns NULL,
  638.   it no item is found.
  639.  
  640. INPUTS
  641.   menu   : the root menu
  642.   id     : the id of the searched menu item
  643.  
  644. RETURNS
  645.   item   : a pointer to the item or NULL
  646.  
  647.  
  648.  
  649.  
  650. egsintui.library/EI_FindSubMenu
  651.  
  652. NAME
  653.   EI_FindSubMenu
  654.  
  655. SYNOPSIS
  656.   submenu = EI_FindSubMenu(menu, id)
  657.   D0                       A0    D0
  658.  
  659.   EI_MenuPtr       submenu;
  660.   EI_MenuPtr       menu;
  661.   LONG             id;
  662.  
  663. FUNCTION
  664.   Searches recursively for a menu item in the described menu. Returns NULL,
  665.   it no item is found, or the sub menu that contains the item.
  666.  
  667. INPUTS
  668.   menu    : the root menu
  669.   id      : the id of the searched menu item
  670.  
  671. RETURNS
  672.   submenu : a pointer to the sub menu that contains the item
  673.  
  674.  
  675.  
  676. egsintui.library/EI_FreeMenu
  677.  
  678. NAME
  679.   EI_FreeMenu   free the memory associated to a menue
  680.  
  681. SYNOPSIS
  682.   EI_FreeMenu(menu);
  683.           A0
  684.  
  685.   EI_MenuPtr  menu;
  686.  
  687. FUNCTION
  688.   Returns the memory that was allocated for a menu, using EI_CreateMenu and
  689.   EI_CreateItem back to the free memory pool. This is done recursively for
  690.   all submenues and items. So you need only one call to clean up a menu and
  691.   all its submenues and items. Make sure that you only free items and menus
  692.   that have been allocated using EI_CreateMenu, EI_CreateItem and
  693.   EI_CreateLeave.
  694.  
  695. INPUTS
  696.   menu   : Menustructure that has been allocated by EI_CreateMenu etc.
  697.  
  698. RETURNS
  699.  
  700.  
  701.  
  702.  
  703. egsintui.library/EI_GetDefaultScreen
  704.  
  705. NAME
  706.   EI_GetDefaultScreen   return a pointer to the default NewScreen
  707.  
  708. SYNOPSIS
  709.   newscr = EI_GetDefaultScreen();
  710.   D0
  711.  
  712.   EI_NewScreenPtr  newscr;
  713.  
  714. FUNCTION
  715.   Returns a pointer to the "NewScreen" structure of the default screen.
  716.   You might use this function to clone the default screen. If you need some
  717.   information of the default screen before you open a window on it, it is
  718.   suggested to open an offscreen window, and retrieve the information there.
  719.  
  720. INPUTS
  721.  
  722. RETURNS
  723.  
  724.  
  725.  
  726.  
  727. egsintui.library/EI_GetPrefFont
  728.  
  729. NAME
  730.   EI_GetPrefFont   get one of the preferences fonts
  731.  
  732. SYNOPSIS
  733.   font =  EI_GetPrefFont(type)
  734.   D0                     D0
  735.  
  736.   TextAttr   *font;
  737.   ULONG      type;
  738.  
  739. FUNCTION
  740.   Returns a text attr structure for one of the default fonts. These fonts
  741.   are the user selected and should be used whenever possible.
  742.  
  743. INPUTS
  744.   type    : 0 -> Screenfont
  745.         1 -> Windowfont
  746.         2 -> Systemfont
  747.  
  748. RETURNS
  749.   font    : the selected font, or NULL if not supported
  750.  
  751.  
  752.  
  753. egsintui.library/EI_GetPrefPointer
  754.  
  755. NAME
  756.   EI_GetPrefPointer  get one of the preferences pointers
  757.  
  758. SYNOPSIS
  759.   mouse =  EI_GetPrefPointer(type)
  760.   D0                         D0
  761.  
  762.   E_EMouse       *mouse;
  763.   ULONG          type;
  764.  
  765. FUNCTION
  766.   Returns an egs mouse structure, that may be passed to 'SetPointer'. Valid
  767.   values for type are defined in egsintui.h with prefix 'EIM_'.
  768.  
  769. INPUTS
  770.   type   : Mousetypes (EIM_...)
  771.  
  772. RETURNS
  773.   mouse  : the selected mouse (this is no copy, but the original and may not
  774.        be altered).
  775.  
  776.  
  777.  
  778.  
  779. egsintui.library/EI_GetWinColor
  780.  
  781. NAME
  782.   EI_GetWinColor   get one of the windows color
  783.  
  784. SYNOPSIS
  785.   color = EI_GetWinColor(colors,tag);
  786.  
  787.   ULONG             color;
  788.   EI_ColorTablePtr  colors;
  789.   ULONG             tag;
  790.  
  791. FUNCTION
  792.   Returns one of a screens/windows colors.
  793.  
  794. INPUTS
  795.   colors  : The color table, of a screen or a window
  796.   tag     : One of the colortags from egsintui.h
  797.  
  798. RESULT
  799.   color   : The selected color
  800.  
  801.  
  802.  
  803.  
  804.  
  805. egsintui.library/EI_Interpret
  806.  
  807. NAME
  808.   EI_Interpret   interpret IntuiGfx programm
  809.  
  810. SYNOPSIS
  811.   EI_Interpret(rast, colors, toff, prog, x, y)
  812.            A0    A1      A2    A3    D0 D1
  813.  
  814.   EG_RastPortPtr   rast;
  815.   IG_WinColorsPtr  colors;
  816.   IG_IntuiGfxPtr   toff, prog;
  817.   WORD             x, y;
  818.  
  819. FUNCTION
  820.   Interperts an intuiGfx programm (see also intuigfx.doc)
  821.  
  822. INPUTS
  823.   rast   : rastport to draw in
  824.   colors : wincolors from window
  825.   toff   : pointer to sufficient stack space (stacktop)
  826.   prog   : pointer to first command
  827.   x, y   : starting location
  828.  
  829. RETURNS
  830.  
  831.  
  832.  
  833.  
  834. egsintui.library/EI_Interpret1Param
  835.  
  836. NAME
  837.   EI_Interpret1Param   interpret IntuiGfx programm
  838.  
  839. SYNOPSIS
  840.   EI_Interpret1Param(rast, colors, prog, x, y, para1)
  841.              A0    A1      A2    D0 D1 D2
  842.  
  843.   EG_RastPortPtr   rast;
  844.   IG_WinColorsPtr  colors;
  845.   IG_IntuiGfxPtr   prog;
  846.   WORD             x, y;
  847.   LONG             para1;
  848.  
  849. FUNCTION
  850.   Interpret IntuiGfx programm with one parameter (see also intuigfx.doc),
  851.   allocates own stack with 256 entries.
  852.  
  853. INPUTS
  854.   rast   : rastport to draw in
  855.   colors : wincolors from window
  856.   prog   : pointer to first command
  857.   x, y   : starting location
  858.   para1  : parameter
  859.  
  860. RETURNS
  861.  
  862.  
  863.  
  864.  
  865. egsintui.library/EI_Interpret2Param
  866.  
  867. NAME
  868.   EI_Interpret2Param   interpret IntuiGfx programm
  869.  
  870. SYNOPSIS
  871.   EI_Interpret2Param(rast, colors, prog, x, y, para1, para2)
  872.              A0    A1      A2    D0 D1 D2     D3
  873.  
  874.   EG_RastPortPtr   rast;
  875.   IG_WinColorsPtr  colors;
  876.   IG_IntuiGfxPtr   prog;
  877.   WORD             x, y;
  878.   LONG             para1, para2;
  879.  
  880. FUNCTION
  881.   Interpret IntuiGfx programm with two parameters (see also intuigfx.doc),
  882.   allocates own stack with 256 entries.
  883.  
  884. INPUTS
  885.   rast   : rastport to draw in
  886.   colors : wincolors from window
  887.   prog   : pointer to first command
  888.   x, y   : starting location
  889.   para1  : parameter 1
  890.   para2  : parameter 2
  891.  
  892. RETURNS
  893.  
  894.  
  895.  
  896.  
  897. egsintui.library/EI_InterpretStacked
  898.  
  899. NAME
  900.   EI_InterpretStacked   interpret IntuiGfx programm
  901.  
  902. SYNOPSIS
  903.   EI_InterpretStacked(rast, colors, prog, x, y)
  904.               A0    A1      A2    D0 D1
  905.  
  906.   EG_RastPortPtr   rast;
  907.   IG_WinColorsPtr  colors;
  908.   IG_IntuiGfxPtr   prog;
  909.   WORD             x, y;
  910.  
  911. FUNCTION
  912.   Interpret IntuiGfx programm without parameters (see also intuigfx.doc),
  913.   allocates own stack with 256 entries.
  914.  
  915. INPUTS
  916.   rast   : rastport to draw in
  917.   colors : wincolors from window
  918.   prog   : pointer to first command
  919.   x, y   : starting location
  920.  
  921. RETURNS
  922.  
  923.  
  924.  
  925.  
  926. egsintui.library/EI_LockIntuition
  927.  
  928. NAME
  929.   EI_LockIntuition   lock intuition
  930.  
  931. SYNOPSIS
  932.   EI_LockIntuition()
  933.  
  934. FUNCTION
  935.   Locks intuition. No user or window actions can take place if intuition is
  936.   locked. This call must be paired by EI_UnlockIntuition.
  937.  
  938. INPUTS
  939.  
  940. RETURNS
  941.  
  942.  
  943.  
  944.  
  945. egsintui.library/EI_ModifyIDCMP
  946.  
  947. NAME
  948.   EI_ModifyIDCMP   modifies windows idcmp
  949.  
  950. SYNOPSIS
  951.   EI_ModifyIDCMP(win, flags)
  952.          A0   D0
  953.  
  954.   EI_WindowPtr    win;
  955.   ULONG           flags;
  956.  
  957. FUNCTION
  958.   Wodifies a windows idcmp flags. Opens or closes the port if necessary. If
  959.   the window has its own port (not created by intui..), this port will be
  960.   untouched.
  961.  
  962. INPUTS
  963.   win   : pointer to window
  964.   flags : flagset of EI_EIDCMPFlags
  965.  
  966. RETURNS
  967.  
  968.  
  969.  
  970.  
  971. egsintui.library/EI_MoveWindow
  972.  
  973. NAME
  974.   EI_MoveWindow   moves a window
  975.  
  976. SYNOPSIS
  977.   EI_MoveWindow(win, dx, dy)
  978.         A0   D0  D1
  979.  
  980.   EI_WindowPtr   win;
  981.   WORD           dx, dy;
  982.  
  983. FUNCTION
  984.   Moves a window by dx, dy. The window may be moved out of the screen. This
  985.   function may cause refresh events.
  986.  
  987. INPUTS
  988.  
  989. RETURNS
  990.  
  991.  
  992.  
  993.  
  994. egsintui.library/EI_ObtainColor
  995.  
  996. NAME
  997.   EI_ObtainColor   obtain one of a screens color
  998.  
  999. SYNOPSIS
  1000.   color = EI_ObtainColor(scr,red,green,blue);
  1001.   D0                     A0  D0  D1    D2
  1002.  
  1003.   ULONG         color;
  1004.   EI_ScreenPtr  scr;
  1005.   UBYTE         red,green,blue;
  1006.  
  1007. FUNCTION
  1008.   Locks a colorregister of the screen for usage with red/green/blue or
  1009.   returns the 24 bit color value associated to red/green/blue. You have to
  1010.   release this color, if you do not need it anymore. But notice, that the
  1011.   color register may be reused at once, so make sure that nothing is
  1012.   rendered in this color before you release it. If no color register is free
  1013.   and no used one is close enough, this function will return the 24 color
  1014.   value itself. The egsgfx and egsblit library will use this value and
  1015.   approximate it by dithering.
  1016.  
  1017. INPUTS
  1018.   scr             : The screen on which the color is to be used
  1019.   red,green,blue  : The color values that build the color
  1020.  
  1021. RESULTS
  1022.   color           : A color value that can be used for egsgfx and egsblit
  1023.  
  1024.  
  1025.  
  1026.  
  1027. egsintui.library/EI_OffGadget
  1028.  
  1029. NAME
  1030.   EI_OffGadget   deactivate gadget
  1031.  
  1032. SYNOPSIS
  1033.   EI_OffGadget(win, gad)
  1034.            A0   A1
  1035.  
  1036.   EI_WindowPtr   win;
  1037.   EI_GadgetPtr   gad;
  1038.  
  1039. FUNCTION
  1040.   Deaactivates a gadget and draws its passive rendering (see structures
  1041.   for more information). The gadget can not be reached by the user if it
  1042.   is deactivated. The gadget can be reactivated using EI_OnGadget. If the
  1043.   gadget is a master gadget, all of its son gadgets are also deactivated.
  1044.  
  1045. INPUTS
  1046.  
  1047. RETURNS
  1048.  
  1049.  
  1050.  
  1051.  
  1052. egsintui.library/EI_OffGList
  1053.  
  1054. NAME
  1055.   EI_OffGList    deactivate several gadgets
  1056.  
  1057. SYNOPSIS
  1058.   EI_OffGList(win, gad, num)
  1059.           A0   A1   D0
  1060.  
  1061.   EI_WindowPtr   win;
  1062.   EI_GadgetPtr   gad;
  1063.   WORD           num;
  1064.  
  1065. FUNCTION
  1066.   Deaactivates a list of gadgets and draws their passive rendering (see
  1067.   structures for more information). The gadgets can not be reached by the user
  1068.   if they are deactivated. The gadgets can be reactivated using EI_OnGList.
  1069.   If the list contains a master gadget, all of its son gadgets are also
  1070.   deactivated.
  1071.  
  1072. INPUTS
  1073.   win    : pointer to window
  1074.   gad    : pointer to first gadget in list
  1075.   num    : number of gadgets in list
  1076.  
  1077. RETURNS
  1078.  
  1079.  
  1080.  
  1081. egsintui.library/EI_OffMenuItem
  1082.  
  1083. NAME
  1084.   EI_OffMenuItem    deactivates a menu item
  1085.  
  1086. SYNOPSIS
  1087.   EI_OffMenuItem(menu,item);
  1088.  
  1089.   EI_MenuPtr      menu;
  1090.   EI_MenuItemPtr  item;
  1091.  
  1092. FUNCTION
  1093.   Deactivates a menu item, and makes it unselectable.
  1094.  
  1095. INPUT
  1096.   menu     : The menu that contains the item
  1097.   item     : The item itself
  1098.  
  1099. RESULTS
  1100.  
  1101.  
  1102.  
  1103.  
  1104. egsintui.library/EI_OnGadget
  1105.  
  1106. NAME
  1107.   EI_OnGadget   activate a gadget
  1108.  
  1109. SYNOPSIS
  1110.   EI_OnGadget(win, gad)
  1111.           A0   A1
  1112.  
  1113.   EI_WindowPtr   win;
  1114.   EI_GadgetPtr   gad;
  1115.  
  1116. FUNCTION
  1117.   Activates a gadget, and draws its active rendering. The gadget can now be
  1118.   reached by the user. If it is a master gadget then all son gadgets are
  1119.   activated too.
  1120.  
  1121. INPUTS
  1122.  
  1123. RETURNS
  1124.  
  1125.  
  1126.  
  1127.  
  1128. egsintui.library/EI_OnGList
  1129.  
  1130. NAME
  1131.   EI_OnGList   activate several gadgets
  1132.  
  1133. SYNOPSIS
  1134.   EI_OnGList(win, gad, num)
  1135.          A0   A1   D0
  1136.  
  1137.   EI_WindowPtr   win;
  1138.   EI_GadgetPtr   gad;
  1139.   WORD           num;
  1140.  
  1141. FUNCTION
  1142.   Activates a list of gadgets, and draws their active rendering. The gadgets
  1143.   can now be reached by the user. If there is a master gadget in the list then
  1144.   all son gadgets are activated too.
  1145.  
  1146. INPUTS
  1147.   win    : pointer to window
  1148.   gad    : pointer to first gadget in list
  1149.   num    : number of gadgets in list
  1150.  
  1151. RETURNS
  1152.  
  1153.  
  1154.  
  1155.  
  1156. egsintui.library/EI_OnMenuItem
  1157.  
  1158. NAME
  1159.   EI_OnMenuItem    activates a menu item
  1160.  
  1161. SYNOPSIS
  1162.   EI_OnMenuItem(menu,item);
  1163.  
  1164.   EI_MenuPtr      menu;
  1165.   EI_MenuItemPtr  item;
  1166.  
  1167. FUNCTION
  1168.   Activates a menu item, and makes it selectable again.
  1169.  
  1170. INPUT
  1171.   menu     : The menu that contains the item
  1172.   item     : The item itself
  1173.  
  1174. RESULTS
  1175.  
  1176.  
  1177.  
  1178.  
  1179. egsintui.library/EI_OpenScreen
  1180.  
  1181. NAME
  1182.   EI_OpenScreen    opens a screen
  1183.  
  1184. SYNOPSIS
  1185.   scr = EI_OpenScreen(newScreen)
  1186.   D0                  A0
  1187.  
  1188.   EI_ScreenPtr          scr;
  1189.   struct EI_NewScreen * newScreen;
  1190.  
  1191. FUNCTION
  1192.   Opens a screen that is able to contain windows. Initialises all needed
  1193.   structures like E_EScreen, EL_LayerInfo or EG_RastPort. This screen must
  1194.   be closed using EI_CloseScreen.
  1195.  
  1196. INPUTS
  1197.   newScreen   : filled EI_NewScreen structure, containing all informations
  1198.         needed to open the screen
  1199.  
  1200. RETURNS
  1201.   a fully initialized screen pointer, or NULL if failed.
  1202.  
  1203.  
  1204.  
  1205.  
  1206. egsintui.library/EI_OpenWindow
  1207.  
  1208. NAME
  1209.   EI_OpenWindow   open a window
  1210.  
  1211. SYNOPSIS
  1212.   win = EI_OpenWindow(new)
  1213.   D0                  A0
  1214.  
  1215.   EI_WindowPtr          win;
  1216.   struct EI_NewWindow * new;
  1217.  
  1218. FUNCTION
  1219.   Opens a window on an EI_Screen, or the default screen, if none specified.
  1220.   If this is the first window on the default screen, also opens the
  1221.   default screen. This window must be closed using EI_CloseWindow.
  1222.  
  1223. INPUTS
  1224.   new       : filled EI_NewWindow structure, containing all informations
  1225.           needed to open a window
  1226.  
  1227. RETURNS
  1228.   a handle to an open window, or NULL if failed.
  1229.  
  1230.  
  1231.  
  1232.  
  1233. egsintui.library/EI_PutMenuHome
  1234.  
  1235. NAME
  1236.   EI_PutMenuHome   put menu back in strip
  1237.  
  1238. SYNOPSIS
  1239.   EI_PutMenuHome(menu)
  1240.          A0
  1241.  
  1242.   EI_MenuPtr  menu;
  1243.  
  1244. FUNCTION
  1245.   Puts a menu, which has been extracted from the menu strip back to the
  1246.   strip.
  1247.  
  1248. INPUTS
  1249.  
  1250. RETURNS
  1251.  
  1252.  
  1253.  
  1254.  
  1255. egsintui.library/EI_PutMenuOut
  1256.  
  1257. NAME
  1258.   EI_PutMenuOut   extract menu from strip
  1259.  
  1260. SYNOPSIS
  1261.   EI_PutMenuOut(menu, win, x, y)
  1262.         A0    A1   D0 D1
  1263.  
  1264.   EI_MenuPtr   menu;
  1265.   EI_WindowPtr win;
  1266.   WORD         x, y;
  1267.  
  1268. FUNCTION
  1269.   Extract a menu from its menu strip. The menu then stays open, and can be
  1270.   moved around the screen as a layer. The menu can be put back using
  1271.   EI_PutMenuHome. The same can be achieved by the user, using a special
  1272.   menu item (see structures for more information)
  1273.  
  1274. INPUTS
  1275.   menu    : pointer to menu to extract
  1276.   win     : window to which the menu belongs
  1277.   x, y    : upper left edge, where the menu first appears
  1278.  
  1279. RETURNS
  1280.  
  1281.  
  1282.  
  1283.  
  1284. egsintui.library/EI_RedrawGadgetList
  1285.  
  1286. NAME
  1287.   EI_RedrawGadgetList
  1288.  
  1289. SYNOPSIS
  1290.   EI_RedrawGadgetList(win, border, inside)
  1291.               A0   D0      D1
  1292.  
  1293.   EI_WindowPtr  win;
  1294.   BOOL          border, inside;
  1295.  
  1296. FUNCTION
  1297.  
  1298. INPUTS
  1299.  
  1300. RETURNS
  1301.  
  1302.  
  1303.  
  1304.  
  1305. egsintui.library/EI_RefreshGadget
  1306.  
  1307. NAME
  1308.   EI_RefreshGadget    refresh a gadget
  1309.  
  1310. SYNOPSIS
  1311.   EI_RefreshGadget(win, gad)
  1312.            A0   A1
  1313.  
  1314.   EI_WindowPtr    win;
  1315.   EI_GadgetPtr    gad;
  1316.  
  1317. FUNCTION
  1318.   Refreshes a gadget, by recalculating all asociated elements (propgadget)
  1319.   and redraws it. This function has to be called if the gadget is modified
  1320.   by a programm, to show its new state. If the gadget is a master gadget then
  1321.   all son gadgets are refreshed too. Refresh caused by obscured gadget parts
  1322.   is carried out by EGSIntui automagically.
  1323.  
  1324. INPUTS
  1325.  
  1326. RETURNS
  1327.  
  1328.  
  1329.  
  1330.  
  1331. egsintui.library/EI_RefreshGList
  1332.  
  1333. NAME
  1334.   EI_RefreshGList    refresh several gadgets
  1335.  
  1336. SYNOPSIS
  1337.   EI_RefreshGList(win, gad, num)
  1338.           A0   A1   D0
  1339.  
  1340.   EI_WindowPtr  win;
  1341.   EI_GadgetPtr  gad;
  1342.   WORD          num;
  1343.  
  1344. FUNCTION
  1345.   Refreshes a list of gadgets, by recalculating all asociated elements
  1346.   (propgadget) and redraws them. This function has to be called if gadget are
  1347.   modified by a programm, to show their new state. If a gadget in the list is a
  1348.   master gadget then all son gadgets are refreshed too.
  1349.  
  1350. INPUTS
  1351.   win    : pointer to window
  1352.   gad    : pointer to first gadget in list
  1353.   num    : number of gadgets in list
  1354.  
  1355. RETURNS
  1356.  
  1357.  
  1358.  
  1359.  
  1360. egsintui.library/EI_ReleaseColor
  1361.  
  1362. NAME
  1363.   EI_ReleaseColor   frees a color of a screen
  1364.  
  1365. SYNOPSIS
  1366.   EI_ReleaseColor(scr,color);
  1367.           A0  D0
  1368.  
  1369.   EI_ScreenPtr  scr;
  1370.   ULONG         color;
  1371.  
  1372. FUNCTION
  1373.   Returns a color register that was locked using "EI_ObtainColor" or
  1374.   "EI_CloneColor" back to the free pool. The color of this register may
  1375.   change at once, so make sure that there is no rendering in this color
  1376.   left. If the color is 24 bit value nothing is done.
  1377.  
  1378. INPUTS
  1379.  
  1380. RETURNS
  1381.  
  1382.  
  1383.  
  1384.  
  1385. egsintui.library/EI_RemoveGadget
  1386.  
  1387. NAME
  1388.   EI_RemoveGadget   removes a gadget
  1389.  
  1390. SYNOPSIS
  1391.   EI_RemoveGadget(win, gad)
  1392.           A0   A1
  1393.  
  1394.   EI_WindowPtr  win;
  1395.   EI_GadgetPtr  gad;
  1396.  
  1397. FUNCTION
  1398.   Removes a gadget from a windows gadget list, and fills its former location
  1399.   with the windows background color. If the gadget is a master gadget, then
  1400.   all son gadgets are removed too.
  1401.  
  1402. INPUTS
  1403.  
  1404. RETURNS
  1405.  
  1406.  
  1407.  
  1408.  
  1409. egsintui.library/EI_RemoveGList
  1410.  
  1411. NAME
  1412.   EI_RemoveGList   remove several gadgets
  1413.  
  1414. SYNOPSIS
  1415.   EI_RemoveGList(win, gad, num)
  1416.          A0   A1   D0
  1417.  
  1418.   EI_WindowPtr  win;
  1419.   EI_GadgetPtr  gad;
  1420.   WORD          num;
  1421.  
  1422. FUNCTION
  1423.   Removes a list of gadgets from a windows gadget list, and fills their former
  1424.   location with the windows background color. If a gadget in the list is a
  1425.   mastergadget, then all son gadgets are removed too.
  1426.  
  1427. INPUTS
  1428.   win    : pointer to window
  1429.   gad    : pointer to first gadget in list
  1430.   num    : number of gadgets in list
  1431.  
  1432. RETURNS
  1433.  
  1434.  
  1435.  
  1436.  
  1437. egsintui.library/EI_ReportMouse
  1438.  
  1439. NAME
  1440.   EI_ReportMouse   determines if mouse moves shall be send
  1441.  
  1442. SYNOPSIS
  1443.   EI_ReportMouse(win, flag)
  1444.          A0   D0
  1445.  
  1446.   EI_WindowPtr   win;
  1447.   BOOL           flag;
  1448.  
  1449. FUNCTION
  1450.   Determines wether mouse move messages shall be send to a window or not.
  1451.   If flag is true, then following mouse moves will be broadcasted to your
  1452.   window, else not. To receive mouse moves you also have to set
  1453.   EI_iMouseMove in your eidcmpflags.
  1454.  
  1455. INPUTS
  1456.  
  1457. RETURNS
  1458.  
  1459.  
  1460.  
  1461.  
  1462. egsintui.library/EI_ScrollWindow
  1463.  
  1464. NAME
  1465.   EI_ScrollWindow  scroll a window
  1466.  
  1467. SYNOPSIS
  1468.   EI_ScrollWindow(win, dx, dy)
  1469.           A0   D0  D1
  1470.  
  1471.   EI_WindowPtr  win;
  1472.   WORD          dx, dy;
  1473.  
  1474. FUNCTION
  1475.   Scrolls the interiour of a window by dx, dy. This function only works
  1476.   with GimmeZeroZero or borderless windows. This function also modifies
  1477.   the coordinates of the windows upper left corner.
  1478.  
  1479. INPUTS
  1480.  
  1481. RETURNS
  1482.  
  1483.  
  1484.  
  1485.  
  1486. egsintui.library/EI_SetMenuStrip
  1487.  
  1488. NAME
  1489.   EI_SetMenuStrip   sets new menu strip
  1490.  
  1491. SYNOPSIS
  1492.   EI_SetMenuStrip(win, menu)
  1493.           A0   A1
  1494.  
  1495.   EI_WindowPtr  win;
  1496.   EI_MenuPtr    menu;
  1497.  
  1498. FUNCTION
  1499.   Sets a new menu strip for a window. EI_SetMenuStrip(win,NIL) clears the
  1500.   current menu strip. This function puts all extracted submenus back to
  1501.   the strip.
  1502.  
  1503. INPUTS
  1504.  
  1505. RETURNS
  1506.  
  1507.  
  1508.  
  1509.  
  1510. egsintui.library/EI_SetPointer
  1511.  
  1512. NAME
  1513.   EI_SetPointer   sets a mouse pointer for a window
  1514.  
  1515. SYNOPSIS
  1516.   EI_SetPointer(win, mouse)
  1517.         A0   A1
  1518.  
  1519.   EI_WindowPtr  win;
  1520.   E_EMousePtr   mouse;
  1521.  
  1522. FUNCTION
  1523.   Sets a custom mouse pointer for a window. If the window is active, the
  1524.   pointer will change immediately, otherwise it will change, when this window
  1525.   is activated.
  1526.  
  1527. INPUTS
  1528.  
  1529. RETURNS
  1530.  
  1531.  
  1532.  
  1533.  
  1534. egsintui.library/EI_SetWindowTitles
  1535.  
  1536. NAME
  1537.   EI_SetWindowTitles    modify window/screen title
  1538.  
  1539. SYNOPSIS
  1540.   EI_SetWindowTitles(win, wTitle, sTitle)
  1541.              A0   A1      A2
  1542.  
  1543.   EI_WindowPtr   win;
  1544.   CHAR *         wTitle, sTiile;
  1545.  
  1546. FUNCTION
  1547.   Modifies a windows and/or screens title. Usage of -1 instead of a pointer
  1548.   to a text will not effect the current title, NULL clears the title.
  1549.  
  1550. INPUTS
  1551.   win     : window pointer
  1552.   wTitle  : title to appear in the windows title
  1553.   sTitle  : title to appear in the screens title, when window is active
  1554.  
  1555. RETURNS
  1556.  
  1557.  
  1558.  
  1559.  
  1560. egsintui.library/EI_SizeWindow
  1561.  
  1562. NAME
  1563.   EI_SizeWindow   change window size
  1564.  
  1565. SYNOPSIS
  1566.   EI_SizeWindow(win, dx, dy)
  1567.         A0   D0  D1
  1568.  
  1569.   EI_WindowPtr  win;
  1570.   WORD          dx, dy;
  1571.  
  1572. FUNCTION
  1573.   Changes a windows visible size. This function may cause a refresh message
  1574.   to be broadcasted.
  1575.  
  1576. INPUTS
  1577.  
  1578. RETURNS
  1579.  
  1580.  
  1581.  
  1582.  
  1583. egsintui.library/EI_SleepWindow
  1584.  
  1585. NAME
  1586.   EI_SleepWindow   put a window to sleep
  1587.  
  1588. SYNOPSIS
  1589.   EI_SleepWindow(win)
  1590.          A0
  1591.  
  1592.   EI_WindowPtr   win;
  1593.  
  1594. FUNCTION
  1595.   Puts a window to sleep. A sleeping window gets no input events and can not
  1596.   be resized using the sizing gadget. The only message that is passed is
  1597.   an eventuall refresh message. This function may be handy for modal requests.
  1598.   The window can be awakened again using "WakeWindow".
  1599.  
  1600. INPUTS
  1601.  
  1602. RETURNS
  1603.  
  1604.  
  1605.  
  1606.  
  1607. egsintui.library/EI_SysRequest
  1608.  
  1609. NAME
  1610.   EI_SysRequest   make system request
  1611.  
  1612. SYNOPSIS
  1613.   response = EI_SysRequest(win, title, bodyTxt, gadgTxt)
  1614.   D0                       A0   A1     A2       A3
  1615.  
  1616.   WORD          response;
  1617.   EI_WindowPtr  win;
  1618.   CHAR *        title, bodyTxt, gadgTxt;
  1619.  
  1620. FUNCTION
  1621.   Creates and opens a system request, on a windows screen, or the default
  1622.   screen. Then it waits for the user to answer the request, by clicking on
  1623.   one of the buttons.
  1624.   The request text may have several lines and several gadgets by seperating
  1625.   them through a "|".
  1626.  
  1627. EXAMPLE
  1628.   res = EI_SysRequest(mywin, "Request",
  1629.               "Not enough memory|to proceed",
  1630.               "RETRY|IGNORE|CANCEL");
  1631.  
  1632. INPUTS
  1633.   win     : window on which screen the requester shall appear, or NULL for
  1634.         default screen
  1635.   title   : requesters title
  1636.   bodyTxt : text in the requesters body, lines seperated by "|"
  1637.   gadgTxt : text of the gadgets, seperated by "|"
  1638.  
  1639. RETURNS
  1640.   the number of the gadget, that was pressed
  1641.  
  1642.  
  1643.  
  1644.  
  1645. egsintui.library/EI_ToggleMenuItem
  1646.  
  1647. NAME
  1648.   EI_ToggleMenuItem   toggles the state of a menu item
  1649.  
  1650. SYNOPSIS
  1651.   EI_ToggleMenuItem(menu,item)
  1652.             A0   A1
  1653.  
  1654.   EI_MenuPtr      menu;
  1655.   EI_MenuItemPtr  item;
  1656.  
  1657. FUNCTION
  1658.   Toggles the state (checkmark) of a toggle menu item. If the menu resides
  1659.   on the screen, the change will be noticeable at once.
  1660.  
  1661. INPUTS
  1662.  
  1663. RETURNS
  1664.  
  1665.  
  1666.  
  1667.  
  1668. egsintui.library/EI_UnlockIntuition
  1669.  
  1670. NAME
  1671.   EI_UnlockIntuition    unlocks intuition
  1672.  
  1673. SYNOPSIS
  1674.   EI_UnlockIntuition()
  1675.  
  1676. FUNCTION
  1677.   Partner to EI_LockIntuition
  1678.  
  1679. INPUTS
  1680.  
  1681. RETURNS
  1682.  
  1683.  
  1684.  
  1685.  
  1686. egsintui.library/EI_WakeWindow
  1687.  
  1688. NAME
  1689.   EI_WakeWindow    return window from sleeping state
  1690.  
  1691. SYNOPSIS
  1692.   EI_WakeWindow(win)
  1693.         A0
  1694.  
  1695.   EI_WindowPtr   win;
  1696.  
  1697. FUNCTION
  1698.   Returns a window back from the sleeping state to active duty.
  1699.  
  1700. INPUTS
  1701.  
  1702. RETURNS
  1703.  
  1704.  
  1705.  
  1706.  
  1707. egsintui.library/EI_WindowBorder
  1708.  
  1709. NAME
  1710.   EI_WindowBorder   modify maximum size of window
  1711.  
  1712. SYNOPSIS
  1713.   EI_WindowBorder(win, dx, dy)
  1714.           A0   D0  D1
  1715.  
  1716.   EI_WindowPtr   win;
  1717.   WORD           dx, dy;
  1718.  
  1719. FUNCTION
  1720.   Modifies the maximum size of a window by dx, dy.
  1721.  
  1722. INPUTS
  1723.  
  1724. RETURNS
  1725.  
  1726.  
  1727.  
  1728.  
  1729. egsintui.library/EI_WindowToBack
  1730.  
  1731. NAME
  1732.   EI_WindowToBack   move window back
  1733.  
  1734. SYNOPSIS
  1735.   EI_WindowToBack(win)
  1736.           A0
  1737.  
  1738.   EI_WindowPtr  win;
  1739.  
  1740. FUNCTION
  1741.   Moves a window behind all others on the screen, this function may cause
  1742.   refresh messages.
  1743.  
  1744. INPUTS
  1745.  
  1746. RETURNS
  1747.  
  1748.  
  1749.  
  1750.  
  1751. egsintui.library/EI_WindowToFront
  1752.  
  1753. NAME
  1754.   EI_WindowToFront   move window to front
  1755.  
  1756. SYNOPSIS
  1757.   EI_WindowToFront(win)
  1758.            A0
  1759.  
  1760.   EI_WindowPtr  win;
  1761.  
  1762. FUNCTION
  1763.   Moves a window in front of all other windows on a screen. This function
  1764.   may cause refresh messages.
  1765.  
  1766. INPUTS
  1767.  
  1768. RETURNS
  1769.  
  1770.  
  1771.  
  1772.  
  1773.